home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Graphics / Graphic Demos / MacBubbles™ Demo / Macbubbles Docs next >
Encoding:
Text File  |  1988-04-27  |  18.9 KB  |  490 lines  |  [TEXT/ttxt]

  1. OVERVIEW
  2.  
  3. MacBubbles was developed to fill a role equivalent to that of a word processor 
  4. with respect to a structured specification.  Think of it as a "specification 
  5. processor."  It has features equivalent to the spell checking and index 
  6. preparation features of a word processor, but the only intelligence is what you 
  7. bring to the process.  Our motto might be "Instant DFD's just add an experienced 
  8. analyst and stir."
  9.  
  10. MacBubbles is designed to be easy to learn and easy to use.  The following 
  11. information should help you to get started.
  12.  
  13. MacBubbles has been tested on a Macintosh™ Plus operating with System 4.2, 
  14. Finder 6.0 and LaserWriter Driver 5.0.  Earlier versions have worked with 
  15. System 4.1, Finder 5.5 and LaserWriter 4.0.  HOWEVER, IT WILL NOT WORK with 
  16. some of the earlier LaserWriter drivers.  MacBubbles HAS NOT YET BEEN TESTED ON 
  17. A Mac II.  Users have reported that it does run on a Mac II, but there have 
  18. been setup difficulties.
  19.  
  20. MacBubbles has not yet been tested under Multifinder.  It will not run under 
  21. Multifinder on a 1 Meg Mac.  Reports have been received tha it does run under 
  22. Multifinder on a 2 or 2.5 Meg Mac, but that context switching does not work.
  23.  
  24. An upgrade is being developed that will be fully compatable with the Mac II and 
  25. Multifinder.
  26.  
  27. MacBubbles requires approximately 900K to operate.  The initial screen 
  28. allows you to adjust the memory requirement by changing the size of working
  29. arrays.  BE SURE YOUR RAM CACHE OR PRINT SPOOLER DOESN'T USE SO MUCH MEMORY 
  30. THAT MACBUBBLES WON'T RUN.
  31.  
  32. Graphic output can be directed to the LaserWriter® or HP 7475A plotter.  
  33. Only rough output equivalent to that displayed on the screen can be output
  34. on the ImageWriter®.  Text can be output on a variety of devices.
  35.  
  36.  
  37. WARNINGS
  38.  
  39. Do not try to print more than 10 copies of any multipage document at one time.  
  40. The LaserWriter will time out and the program will crash.  This time out problem
  41. is common to most Macintosh applications.
  42.  
  43. Cut and Paste is limited by the clipboard's capacity.  Cutting large 
  44. parts of a diagram (50+ objects) may crash the system (System Error ID=02).  
  45. SAVE YOUR DIAGRAM BEFORE YOU TRY A LARGE CUT, COPY OR PASTE.  
  46.  
  47. When copying a large diagram to PICT format, the clipboard contents may 
  48. occasionally be garbled.  The symptom of this is a document that fails to print.  
  49. A second attempt with the same diagram generally works.
  50.  
  51.  
  52. COMMANDS AND MENUS
  53.  
  54. All MacBubbles functions are available on one of the follwing eight menus:
  55.  
  56.     File     - I/O functions
  57.  
  58.     Edit     - Graphic edits with full undo facility
  59.  
  60.     Object   - Allows bubbles, boxes, stores and a point to be created and 
  61.                modified
  62.  
  63.     Flow     - Allows data flows to be modified
  64.  
  65.     Defaults - Sets the defaults for new objects and flows.  
  66.                Duplicates the pallet, but has additional capabilities.
  67.  
  68.     Display  - Changes what you see, not what you get.
  69.                Helps in manipulating objects and data flows.
  70.                Can hide display the pallet.
  71.  
  72.     DFD      - Allows you to change diagram data including titles.
  73.                Modifies and displays change information.
  74.                Prints the graphic parameters of a diagram.
  75.                Prints an order form.
  76.  
  77.     "name"  - "name" changes to reflect the file currently open.
  78.               Contains status data.
  79.  
  80.  
  81. TO CREATE AN OBJECT (bubble, store, terminator or point)
  82.  
  83. •  Double click away from any object to create a new object.  The type of 
  84.    object created will depend on the defaults option currently selected.
  85.    (Also shown on the pallet) OR
  86.  
  87. •  Drag from the pallet. OR
  88.  
  89. •  Click away from any object and use the object menu to create an object
  90.    of the desired type.
  91.  
  92.  
  93. TO CREATE A DATA FLOW
  94.  
  95. •  Drag from an unselected object.  OR
  96.  
  97. •  Option drag from a selected object.
  98.  
  99. NOTE: Creating a flow to open space will create a new object of the current 
  100. default type at the end of the flow.
  101.  
  102. NOTE: The type of flow created - regular, dashed, or double arrow - depends on 
  103. the Defaults menu options currently selected.  The pallet can be used to select 
  104. among the three most common types instead of using the Defaults menu. 
  105.  
  106.  
  107. TO REPOSITION AN OBJECT
  108.  
  109. •  Click once on the object to select it, then drag it.  If multiple 
  110.    objects are selected, the entire group will move.
  111.  
  112. •  Option-Drag to move an unselected object.
  113.  
  114.  
  115. TO MODIFY AN OBJECT
  116.  
  117. •  The Object menu provides a number of functions which may be used to modify
  118.    one or more selected objects.
  119.  
  120. •  The first four functions under the Object menu will change all selected 
  121.    objects to the specified type.
  122.  
  123. •  The Increase Size and Reduce Size functions change the size of selected 
  124.    objects in 1 inch (nominal) steps.   However, an object will not be 
  125.    reduced below the 1 inch size.
  126.  
  127. •  The Make Normal Size function will set all selected objects to a nominal
  128.    size of 1 inch.
  129.  
  130. •  The Toggle Dashing function will reverse the current dashing state separately
  131.    for all selected objects.
  132.  
  133. •  The Toggle Transform Shadow function operates on transforms only.  It adds 
  134.    or removes a shadow used in the Ward/Mellor notation to indicate replecated
  135.    functions.
  136.  
  137. •  The Align Objects to Grid will allign all selected object centers to the 
  138.    1/4 inch absolute movement grid.
  139.  
  140.  
  141. TO MODIFY A DATA FLOW
  142.  
  143. •  If handles at the end points of the flow are hidden, click on the center 
  144.    dot of the desired flow first.
  145.  
  146. •  Drag the handle at the desired end to reposition the flow.
  147.  
  148. •  If you drag the end handle far enough from the object, it will break 
  149.    loose and allow you to reconnect it to another object.
  150.  
  151. •  If you stop dragging a flow in free space, a new default object will be
  152.    created as its new terminus.
  153.  
  154. •  If you drag the free end of a flow into the object connected to the other
  155.    end, the flow will be deleted.
  156.  
  157. NOTE: If the option key was down when you began the drag, the stepwise movement
  158. characteristic will be temporarily suspended until the flow end adjustment is 
  159. completed.
  160.  
  161. •  You may also drag the midpoint of a flow to a new location.
  162.  
  163. •  Once the midpoint has been relocated, an additional handle will appear.
  164.    This new handle can be used to change the angular position of the data flow
  165.    at the new center point.
  166.  
  167. •  The Flow menu provides a number of functions which may be used to modify
  168.    one or more selected flows.
  169.  
  170. •  The Reverse Direction function will reverse the direction of each selected 
  171.    flow.
  172.  
  173. •  The Toggle Bidirectional Flow function will change the state of each selected
  174.    flow to or from bidirectional as appropriate.  A bidirectional flow has 
  175.    arrows at both ends.
  176.  
  177. •  The Toggle Dashing will change that characteristic for each selected flow.
  178.  
  179. •  Then Toggle Double Arrow will change that characteristic for each selected 
  180.    flow.  The double arrow is used in the Ward/Mellor notation to indicate a 
  181.    data flow whose value is continuous over time.
  182.  
  183. •  The Release Midpoint function can be used to reset the midpoints of all 
  184.    selected flows to their default positions and remove the extra handles.
  185.  
  186.  
  187. SELECTING THINGS
  188.  
  189. •  Shift clicking works for both objects and flows.
  190.  
  191. •  Drag selecting works only for objects.
  192.  
  193. •  Selecting flows does not affect the objects selected and vice-versa.
  194.  
  195. •  Clicking once in the open deselects everything.
  196.  
  197.  
  198. TO CREATE A NEW CHILD DFD
  199.  
  200. •  Double click on a bubble for which no child DFD exists and click the YES 
  201. button on the Alert window OR
  202.  
  203. •  Select the bubble, choose the Display Child DFD function from the DFD menu 
  204. and click the YES button on the Alert window.
  205.  
  206. •  The child DFD will be created in the same folder as its parent.  Data flows
  207. and stores used by the child will be copied to the new DFD.  The title will be 
  208. set to the title of the parent bubble.
  209.  
  210.  
  211. TO OPEN A CHILD DFD
  212.  
  213. •  Double click on the desired bubble OR
  214.  
  215. •  Select the bubble, choose the Display Child DFD function from the DFD menu.
  216.  
  217. •  The child DFD must be present in the same folder for this to work.
  218.  
  219.  
  220. TO DESIGNATE A PREVIOUSLY CREATED DFD AS THE CHILD OF THE CURRENT DFD
  221.  
  222. •  Select the bubble on the current DFD that represents that DFD.
  223.  
  224. •  Choose the Designate Child DFD function from the DFD menu.
  225.  
  226. •  The child DFD must be present in the same folder for this to work.
  227.  
  228. •  The name of the child DFD will be changed to reflect its new status.
  229.  
  230.  
  231. TO RETURN TO A PREVIOUSLY OPENED PARENT DFD
  232.  
  233. •  Choose the Display Parent DFD function from the DFD menu.
  234.  
  235.  
  236.      ***** ADDITIONAL NOTES *****
  237.  
  238. If an HP 7475 plotter is used, it should be connected to the Modem port.  The
  239. Xon/Xoff protocall is not supported on the printer port.
  240.  
  241.  
  242. DFD SCREEN DISPLAY
  243.  
  244. •  The window shows part of a 100" X 100" work space at 1:1, 2:1, 3:1 or 6:1 
  245.    reduction.  Full scroll bar support is provided.
  246.  
  247. •  The 6:1 reduction is generally useful only for navigating around a large 
  248.    diagram.
  249.  
  250. •  The Stepwise Movement function on the Display menu enables and disables a 
  251.    feature that constrains movement to 1/4-inch steps and angular changes to an 
  252.    amount that depends on the object size.
  253.  
  254. •  Holding down the option key when adjusting the end point of a data flow will 
  255.    also temporarily suspend the stepwise movement feature.
  256.  
  257.  
  258. ADDING TEXT TO THE DIAGRAM
  259.  
  260. •  Newly created objects or flows generally have a text window opened 
  261.    automatically to allow entry of a title.  This text window may obscure all 
  262.    or part of the object.  The Hide Active Title function on the Display menu 
  263.    allows you to close this window at any time.
  264.  
  265. •  When operating at 1:1 scale, the most recently selected object or flow will
  266.    have its title window opened automatically.
  267.  
  268. •  The point object is an exception to the above two rules.  The only way to 
  269.    open its title window is with the Display Active Title function on the Display
  270.    menu.
  271.  
  272. •  Arbitrary text may be added to a diagram by assigning it to points that are 
  273.    not connected to any data flows.  The text may be moved by repositioning 
  274.    these extra points as desired.  
  275.  
  276. •  The automatic opening of a title window for titles at 1:1 scale is controlled
  277.    by the Show Active Title at Full Size function on the Display menu.  When this
  278.    feature is not selected, the title window for an existing object will not 
  279.    automatically reopen every time the object is selected.
  280.  
  281. •  An option drag of an object does not select the object being dragged and will
  282.    not result in opening a title window.
  283.   
  284. •  If a title window would extend beyound the diagram window boundaries, it will 
  285.    not be opened.  If you scroll the diagram window to move the text window 
  286.    nearer the center, the text window will be opened automatically.
  287.  
  288.  
  289. SELECTED OBJECTS AND FLOWS
  290.  
  291. •  Selected objects and flows are highlighted with bold lines on the screen.
  292.  
  293. •  More than one object may be selected at one time.
  294.  
  295. •  More than one flow may be selected at one time.
  296.  
  297. •  Both objects and flows may be selected at the same time.
  298.  
  299. •  Except for Cut, Copy and Blank, all menu functions operate on either objects 
  300.    or flows, but not both.
  301.  
  302. •  Cut, Copy and Blank will base their action on only the selected objects 
  303.    when both objects and flows are selected.  They will act on flows directly 
  304.    only if no objets are selected.  However, Cut, Copy and Blank will affect flows 
  305.    related to the selected objects whether selected or not.
  306.  
  307. •  A selected data store has a handle that may be used to rotate it.
  308.  
  309. •  Normally, a short handle and dot appear at the end of each data flow.  
  310.    This may be used to reposition the data flow as necessary.  The All Line 
  311.    Handles On function of the Display menu enables this feature.  When this 
  312.    function is not checked, one the handles of selected lines will appear.
  313.  
  314.  
  315. EDIT MENU FUNCTIONS
  316.  
  317. •  Nearly all actions have an undo/redo capability associated with them.
  318.  
  319. •  The normal cut and paste commands place descriptive data on the clipboard 
  320.    that is understood only by MacBubbles.
  321.  
  322. •  When an object is CUT, all its flows go with it.  Any flows between two 
  323.    CUT objects or a CUT object and a point are deleted.  Flows between a 
  324.    CUT object and a remaining object are given new terminal points.
  325.  
  326. •  When an object is CLEARed, ALL its flows are deleted as well.  The CLEAR 
  327.    command removes more from the screen than the CUT.
  328.  
  329. •  The cut and copy commands are designed to support the management of a leveled
  330.    set of data flow diagrams.  A future version of MacBubbles will provide an 
  331.    even more convenient facility for leveling and expanding DFDs.
  332.  
  333. •  The development language imposed a limit on the amount of data that can be 
  334.    placed on the clipboard.  
  335.  
  336. •  Normal cut, copy and paste are limited to about 50 objects.  
  337.  
  338.  
  339. PASTING TO OTHER APPLICATIONS
  340.  
  341. •  A special copy command in the File Menu will place a PICT formatted picture 
  342.    on the clipboard.  This picture can then be  pasted into a word processing 
  343.    program like MacWrite and MS Word.
  344.  
  345. •  This copy command actually creates two images.  One in QuickDraw and one in 
  346.    PostScript.  The QuickDraw image is used for screen display and Imagewriter 
  347.    output.  The Postscript image is used for LaserWriter output.
  348.  
  349. •  To conserve limited clipboard space, an option allows you to limit the amount 
  350.    of QuickDraw information pasted to the clipboard.  This will not affect 
  351.    the quality of LaserWriter output, but will affect the amount of detail
  352.    shown on the screen by the word processor.  WHAT YOU SEE IS MUCH LESS THAN
  353.    WHAT YOU WILL GET.
  354.  
  355. •  Pasting a PICT image into a graphics program will generally result in the 
  356.    loss of all the PostScript information created with it.  This is not 
  357.    recommended.
  358.  
  359.  
  360. HARDCOPY OUTPUT
  361.  
  362. •  The primary output device intended for use with MacBubbles is a PostScript 
  363.    capable printer.
  364.  
  365. •  Output may also be created on an HP 7475A plotter.  However, the lower 
  366.    resolution of this device may mean that diagrams intended for output on a 
  367.    PostScript printer will be hard to read on the plotter.
  368.  
  369. •  Rough draft output equivalent to the quality of a 1:1 scale screen image may
  370.    be printed on an ImageWriter printer.  Multiple pages will be printed as 
  371.    necessary to display the entire DFD.
  372.  
  373. •  A draft option is provided for both PostScript printers and plotters.  This 
  374.    mode sacrifices quality for speed.  It does this by suppressing letter 
  375.    rotation on the LaserWriter and by drawing rough lines and clipping data flow 
  376.    text on the plotter.  For example:  DFD 0 in the demo data folder requires 
  377.    about 11 minutes for quality output on the LaserWriter, but only 2 minutes in 
  378.    draft mode.
  379.  
  380. •  MacBubbles normally scales the entire diagram to fit on a single page, but 
  381.    you may set a fixed scale and cause multiple pages to print.  When multiple 
  382.    pages are printed, a 5 percent overlap is provided to make cutting and 
  383.    pasting easier.  For a very large diagram (objects spread across the 
  384.    entire plot area), the scale-to-fit mode results in such small objects 
  385.    that nothing will be displayed!
  386.  
  387.  
  388. HIGHLIGHTING CHANGES
  389.  
  390. •  Special facilities are provided for highlighting recent changes with 
  391.    MacBubbles.  Name changes, changes in the type of an object and the direction
  392.    of a data flow are all recognized.  Positional changes are not considered 
  393.    meaningful for this purpose.
  394.  
  395. •  Every object and flow has eight flags associated with it indicating whether
  396.    it was changed during each of eight user-defined time periods.  Time period 
  397.    zero (0) always represents the current session only.  Time period 1 
  398.    includes all changes since the last time you pressed the Shift Change Bits 
  399.    button on the dialog accessed by the Set Titles & Controls function of the 
  400.    DFD menu.  Time period 2 includes ALL changes since the next prior use of 
  401.    the Shift Change Bits button.  Time period 7 goes back 7 button presses.
  402.    Note that changes in period 1 are always part of periods 2 through 7.
  403.  
  404. •  The Set Titles & Controls function of the DFD menu allows you to start a new
  405.    time period at any time.  When this is done, the existing periods 1-6 are 
  406.    promoted one level and period 7 is lost.
  407.  
  408. •  The Set Change Display function of the DFD menu allows you to determine which 
  409.    time period will be used for highlighting changes.  The numeric time period 
  410.    selected with this function stays the same until another period is selected 
  411.    even though use of the Shift Change Bits button may change the date 
  412.    associated with it.
  413.  
  414. •  Each time the Set Change Display function is used it also selects all changed
  415.    objects and flows on the screen.
  416.  
  417. •  The output device control dialogs are the last element in deteriming how 
  418.    changes are displayed.  Which shipped, MacBubbles will draw changed objects 
  419.    and flows using 1.5 point wide lines on the LaserWriter.  Unchanged material 
  420.    is drawn with .5 point wide lines.  If you wish, these line widths may be 
  421.    changed separately for each type of object.
  422.  
  423. •  Setting the change widths to the same value as the normal widths will 
  424.    suppress the display of changes. 
  425.  
  426. •  Setting a width to 0 will make the matching objects or flows invisible.
  427.  
  428. •  For plotter output, different pens may be selected for different object types
  429.    and for normal and changed objects.  Pen 0 also results in invisible objects.
  430.  
  431.  
  432. DICTIONARY COMPATIBILITY
  433.  
  434. For compatibility with the data dictionary, the following rules should be 
  435. followed:
  436.  
  437. •  Place the ID number of each bubble on the top line rather than the bottom. 
  438.    A small amount of extra space has been added to the hardcopy display for 
  439.    better visual separation and the data dictionary needs the number for 
  440.    balancing checks.  Later versions will provide an option to control ID 
  441.    placement.
  442.  
  443. •  The title of each DFD should include the ID and title of the bubble it 
  444.    describes.  The data dictionary needs this for balancing checks.
  445.  
  446. DFD's that violate the above rules may still be processed by both programs, but 
  447. the data dictionary program may generate incorrect error messages.
  448.  
  449.  
  450. LIMITATIONS OF THIS DEMO VERSION
  451.  
  452. •  You may save new diagrams, but not revised ones.  Any diagram into which
  453.    more than three objects are pasted at one time is considered revised.
  454.  
  455. •  On LaserWriter output, "By MacBubbles" is printed in large gray letters
  456.    on each page.
  457.  
  458. •  On plotter output, "By MacBubbles" is printed at random into some process 
  459.    bubbles.
  460.  
  461. •  The sign-on screen is disabled.  Enter your initials for an ID if you wish.
  462.    Otherwise just press return.  If entered, your initials are saved in a update
  463.    log for each diagram.
  464.  
  465.  
  466. Send comments or trouble reports to:
  467.  
  468. StarSys Inc.
  469. Attn: Richard Cohen
  470. 11113 Norlee Drive
  471. Silver Spring, MD 20902
  472.  
  473. CIS: 74065,64
  474.  
  475.  
  476. ORDERING AND PRICE
  477.  
  478. A two-disk demo of MacBubbls may be ordered from StarSys Inc.  This demo 
  479. includes a demo of the data dictionary program as well as the DFD program.  
  480. It also includes more extensive notes and a set of sample data.  The demo 
  481. costs $25.
  482.  
  483. The price of MacBubbles is $779.99 for single copies.  This price includes 
  484. free upgrades for 12 months.  Discounts start with the second copy.
  485.  
  486. The DFD menu in the MacBubbles program has an option to print an order form.  
  487. The order form function also displays the effect of the multicopy price schedule 
  488. when you enter a number greater than 1 in the number of copies field.
  489.  
  490.